Interface TunnelGroup

All Superinterfaces:
IPCObject
All Known Implementing Classes:
TunnelGroupImpl

public interface TunnelGroup extends IPCObject
Information provided by the PKI file:

    \class TunnelGroup
    
    \brief TunnelGroup handles and manipulates IKE Tunnel Groups.
    
    \example network().getDevice("Router0").getProcess("IpsecProcess").getTunnelGroupAt(0)
    
Author:
Auto-generated
  • Method Details

    • getName

      String getName()
      Information provided by the PKI file:
      
          \brief Returns the Name for the tunnelgroup.
          
          \return string.
          
              
      Returns:
      String Returns a String
    • setName

      void setName(String name)
      Information provided by the PKI file:
      
          \brief Sets the name for the tunnelgroup.
          
          \param string.
          
              
      Parameters:
      name - Takes in a parameter of name
    • getTunnelIpsecAtt

      TunnelIpsecAttribute getTunnelIpsecAtt()
      Information provided by the PKI file:
      
          \brief Returns TunnelIpsecAttribute .
          
          \return TunnelIpsecAttribute, the CTunnelIpsecAttribute object.
          
              
      Returns:
      TunnelIpsecAttribute Returns a TunnelIpsecAttribute
    • getType

      TunnelType getType()
      Information provided by the PKI file:
      
          \brief Return the tunnel type in enum
          eRemoteAccess = 0,
          eL2L = 1,
          eTunnelTypeNone = 2,
          eWebVpn = 3
          
              
      Returns:
      TunnelType Returns a TunnelType
    • getTypeString

      String getTypeString()
      Information provided by the PKI file:
      
          \brief Return the tunnel type in string format
          
              
      Returns:
      String Returns a String
    • setType

      void setType(TunnelType type)
      Information provided by the PKI file:
      
          \brief Set the tunnel type in enum
          \param type
          eRemoteAccess = 0,
          eL2L = 1,
          eTunnelTypeNone = 2,
          eWebVpn = 3
          
              
      Parameters:
      type - Takes in a parameter of type
    • getGeneralAttributes

      TunnelGeneralAttributes getGeneralAttributes()
      Information provided by the PKI file:
      
          \brief Returns TunnelGeneralAttributes .
          
          \return TunnelGeneralAttributes, the CTunnelGeneralAttributes object.
          
              
      Returns:
      TunnelGeneralAttributes Returns a TunnelGeneralAttributes
    • createGeneralAttributes

      TunnelGeneralAttributes createGeneralAttributes()
      Information provided by the PKI file:
      
          \brief Create TunnelGeneralAttributes .
          
          \return TunnelGeneralAttributes, the newly created TunnelGeneralAttributes object.
          
              
      Returns:
      TunnelGeneralAttributes Returns a TunnelGeneralAttributes
    • removeGeneralAttributes

      void removeGeneralAttributes()
      Information provided by the PKI file:
      
          \brief Remove TunnelGeneralAttributes .
          
          \return none